// Go作者版权所有。版权所有。
// 此源代码的使用受BSD样式的约束
// 可以在许可证文件中找到的许可证。

package vet

import (
	"bytes"
	"encoding/json"
	"errors"
	"flag"
	"fmt"
	exec "internal/execabs"
	"log"
	"os"
	"path/filepath"
	"strings"

	"cmd/go/internal/base"
	"cmd/go/internal/cmdflag"
	"cmd/go/internal/work"
)

// 去兽医标志处理
// None
// 我们查询-vettool指定的工具的标志，并接受任何
// 这些标志加上对“go build”有效的任何标志。工具必须
// support-flags，它以JSON格式将其标志的描述打印到
// 斯特杜特。

// vetTool指定要运行的vet命令。
// 支持（尚未发布）vet的任何工具
// 可以提供命令行协议；看见
// golang.org/x/tools/go/analysis/unitchecker for one
// 实施它也用于测试。
// None
// 默认行为（vetTool==“”）运行“go tool vet”。
// None
var vetTool string // -维图尔

func init() {
	work.AddBuildFlags(CmdVet, work.DefaultBuildFlags)
	CmdVet.Flag.StringVar(&vetTool, "vettool", "", "")
}

func parseVettoolFlag(args []string) {
	// 提取-通过特殊标记处理的vettool：
	// 甚至在我们可以声明之前就需要它的值
	// 主标志处理期间可用的标志。
	for i, arg := range args {
		if arg == "-vettool" || arg == "--vettool" {
			if i+1 >= len(args) {
				log.Fatalf("%s requires a filename", arg)
			}
			vetTool = args[i+1]
			return
		} else if strings.HasPrefix(arg, "-vettool=") ||
			strings.HasPrefix(arg, "--vettool=") {
			vetTool = arg[strings.IndexByte(arg, '=')+1:]
			return
		}
	}
}

// vetFlags处理命令行，在第一个非标志处将其拆分
// 进入标志列表和包列表。
func vetFlags(args []string) (passToVet, packageNames []string) {
	parseVettoolFlag(args)

	// 查询vet命令的标志。
	var tool string
	if vetTool == "" {
		tool = base.Tool("vet")
	} else {
		var err error
		tool, err = filepath.Abs(vetTool)
		if err != nil {
			log.Fatal(err)
		}
	}
	out := new(bytes.Buffer)
	vetcmd := exec.Command(tool, "-flags")
	vetcmd.Stdout = out
	if err := vetcmd.Run(); err != nil {
		fmt.Fprintf(os.Stderr, "go vet: can't execute %s -flags: %v\n", tool, err)
		base.SetExitStatus(2)
		base.Exit()
	}
	var analysisFlags []struct {
		Name  string
		Bool  bool
		Usage string
	}
	if err := json.Unmarshal(out.Bytes(), &analysisFlags); err != nil {
		fmt.Fprintf(os.Stderr, "go vet: can't unmarshal JSON from %s -flags: %v", tool, err)
		base.SetExitStatus(2)
		base.Exit()
	}

	// 将vet的标志添加到CmdVet.Flag。
	// None
	// 一些标志，特别是-tags和-v，是兽医已知的，但是
	// 也定义为构建标志。这很好，所以我们在这里省略了重复项。
	// 然而，有些，如-x，是已知的建设，但没有审查。
	isVetFlag := make(map[string]bool, len(analysisFlags))
	cf := CmdVet.Flag
	for _, f := range analysisFlags {
		isVetFlag[f.Name] = true
		if cf.Lookup(f.Name) == nil {
			if f.Bool {
				cf.Bool(f.Name, false, "")
			} else {
				cf.String(f.Name, "", "")
			}
		}
	}

	// 记录GOFLAGS设置的vet工具标志集。我们想把它们传给
	// vet工具，但仅当它们未被显式参数覆盖时。
	base.SetFromGOFLAGS(&CmdVet.Flag)
	addFromGOFLAGS := map[string]bool{}
	CmdVet.Flag.Visit(func(f *flag.Flag) {
		if isVetFlag[f.Name] {
			addFromGOFLAGS[f.Name] = true
		}
	})

	explicitFlags := make([]string, 0, len(args))
	for len(args) > 0 {
		f, remainingArgs, err := cmdflag.ParseOne(&CmdVet.Flag, args)

		if errors.Is(err, flag.ErrHelp) {
			exitWithUsage()
		}

		if errors.Is(err, cmdflag.ErrFlagTerminator) {
			// 所有剩余的参数都必须是包名，但标志终止符为
			// 不包括在内。
			packageNames = remainingArgs
			break
		}

		if nf := (cmdflag.NonFlagError{}); errors.As(err, &nf) {
			// 从现在开始的一切，包括我们刚才讨论的论点-
			// 必须是包名称。
			packageNames = args
			break
		}

		if err != nil {
			fmt.Fprintln(os.Stderr, err)
			exitWithUsage()
		}

		if isVetFlag[f.Name] {
			// 转发原始参数，而不是经过清理的等效参数
			// case-vet工具以特殊的方式解析它们。
			explicitFlags = append(explicitFlags, args[:len(args)-len(remainingArgs)]...)

			// 此标志已被显式重写，因此不要转发其隐式
			// 来自GOFLAGS的值。
			delete(addFromGOFLAGS, f.Name)
		}

		args = remainingArgs
	}

	// 将GOFLAGS中的参数置于其他参数之前。
	CmdVet.Flag.Visit(func(f *flag.Flag) {
		if addFromGOFLAGS[f.Name] {
			passToVet = append(passToVet, fmt.Sprintf("-%s=%s", f.Name, f.Value))
		}
	})
	passToVet = append(passToVet, explicitFlags...)
	return passToVet, packageNames
}

func exitWithUsage() {
	fmt.Fprintf(os.Stderr, "usage: %s\n", CmdVet.UsageLine)
	fmt.Fprintf(os.Stderr, "Run 'go help %s' for details.\n", CmdVet.LongName())

	// 此部分是（*命令）的附加部分。用法：
	cmd := "go tool vet"
	if vetTool != "" {
		cmd = vetTool
	}
	fmt.Fprintf(os.Stderr, "Run '%s help' for a full list of flags and analyzers.\n", cmd)
	fmt.Fprintf(os.Stderr, "Run '%s -help' for an overview.\n", cmd)

	base.SetExitStatus(2)
	base.Exit()
}
